Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[pickers] Replace the onOpen() and onClose() methods of usePickerContext() with a single setOpen() method #15701

Merged
merged 10 commits into from
Dec 4, 2024
Merged

[pickers] Replace the onOpen() and onClose() methods of usePickerContext() with a single setOpen() method #15701

merged 10 commits into from
Dec 4, 2024

Conversation

flaviendelangle
Copy link
Member

@flaviendelangle flaviendelangle commented Dec 2, 2024 •
edited
Loading

While working on #15671, I started to duplicate a lot the handleTogglePicker method.

Changelog

Breaking changes

  • The onOpen and onClose methods of the usePickerContext() hook have been replaced with a single setOpen method — Learn more.

@flaviendelangle flaviendelangle added the component: pickers This is the name of the generic UI component, not the React module! label Dec 2, 2024
@flaviendelangle flaviendelangle self-assigned this Dec 2, 2024
@flaviendelangle flaviendelangle marked this pull request as ready for review December 2, 2024 16:16
@flaviendelangle flaviendelangle changed the title [pickers] Add new method onToggleOpening to the picker public context [pickers] Add new method onToggleOpening to usePickerContext() Dec 2, 2024
@mui-bot
Copy link

mui-bot commented Dec 2, 2024 •
edited
Loading

Deploy preview: https://deploy-preview-15701--material-ui-x.netlify.app/

Updated pages:

Generated by 🚫 dangerJS against d5b36e5

@flaviendelangle flaviendelangle mentioned this pull request Dec 3, 2024
Draft
5 tasks
LukasTy
LukasTy reviewed Dec 3, 2024
View reviewed changes
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we were discussing this exact topic when we were initially introducing the other methods. 😃
I can't think of any harm providing it, if we already feel that it is cleaner in most regular cases. 👌

packages/x-date-pickers/src/internals/components/PickerProvider.tsx Outdated Show resolved Hide resolved
@flaviendelangle
Copy link
Member Author

I think we were discussing this exact topic when we were initially introducing the other methods. 😃

Yes, we were debating between an onToggleXXX and onOpen + onClose.
I think we did the right move to provide onOpen + onClose, but now I think providing both is even better 😆

@flaviendelangle flaviendelangle changed the title [pickers] Add new method onToggleOpening to usePickerContext() [pickers] Replace the onOpen() and onClose() methods of usePickerContext() with a single setOpen() method. Dec 4, 2024
flaviendelangle
flaviendelangle commented Dec 4, 2024
View reviewed changes
packages/x-date-pickers/src/internals/hooks/useOpenState.ts
@@ -8,7 +8,7 @@ export interface OpenStateProps {

export const useOpenState = ({ open, onOpen, onClose }: OpenStateProps) => {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No behavior change, I just aligned the wording a bit

@LukasTy LukasTy added breaking change enhancement This is not a bug, nor a new feature v8.x labels Dec 4, 2024
LukasTy
LukasTy approved these changes Dec 4, 2024
View reviewed changes
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice final result, great job! 👍 💯
I think such cleaner type of API should be sufficient enough and will avoid "analysis-paralysis" (what do I use now... 🤔)😆

docs/data/date-pickers/calendar-systems/AdapterHijri.js Show resolved Hide resolved
docs/data/migration/migration-pickers-v7/migration-pickers-v7.md Outdated Show resolved Hide resolved
packages/x-date-pickers/src/internals/hooks/usePicker/usePickerValue.types.ts Outdated Show resolved Hide resolved
packages/x-date-pickers/src/internals/hooks/usePicker/usePickerValue.types.ts Outdated Show resolved Hide resolved
packages/x-date-pickers/src/internals/hooks/usePicker/usePickerValue.types.ts Outdated Show resolved Hide resolved
flaviendelangle and others added 7 commits December 4, 2024 10:36
@flaviendelangle @LukasTy
Update docs/data/migration/migration-pickers-v7/migration-pickers-v7.md
ef53874 
Co-authored-by: Lukas Tyla <[email protected]>
Signed-off-by: Flavien DELANGLE <[email protected]>
@flaviendelangle @LukasTy
Update packages/x-date-pickers/src/internals/hooks/usePicker/usePicke…
c047749 
…rValue.types.ts

Co-authored-by: Lukas Tyla <[email protected]>
Signed-off-by: Flavien DELANGLE <[email protected]>
@flaviendelangle @LukasTy
Update packages/x-date-pickers/src/internals/hooks/usePicker/usePicke…
e00ff3a 
…rValue.types.ts

Co-authored-by: Lukas Tyla <[email protected]>
Signed-off-by: Flavien DELANGLE <[email protected]>
@flaviendelangle @LukasTy
Update packages/x-date-pickers/src/internals/hooks/usePicker/usePicke…
58e722c 
…rValue.types.ts

Co-authored-by: Lukas Tyla <[email protected]>
Signed-off-by: Flavien DELANGLE <[email protected]>
@flaviendelangle
Merge branch 'master' into ctx-onToggleOpening
756c6d8
@flaviendelangle
Merge remote-tracking branch 'origin/ctx-onToggleOpening' into ctx-on…
8b500ac 
…ToggleOpening
@flaviendelangle
Merge branch 'master' into ctx-onToggleOpening
d5b36e5
@flaviendelangle flaviendelangle merged commit 18a71ef into mui:master Dec 4, 2024
18 checks passed
@flaviendelangle flaviendelangle deleted the ctx-onToggleOpening branch December 4, 2024 10:42
@oliviertassinari oliviertassinari changed the title [pickers] Replace the onOpen() and onClose() methods of usePickerContext() with a single setOpen() method. [pickers] Replace the onOpen() and onClose() methods of usePickerContext() with a single setOpen() method Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LukasTy LukasTy LukasTy approved these changes

@noraleonte noraleonte Awaiting requested review from noraleonte

Assignees

@flaviendelangle flaviendelangle

Labels
breaking change component: pickers This is the name of the generic UI component, not the React module! enhancement This is not a bug, nor a new feature v8.x
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@flaviendelangle @mui-bot @LukasTy